home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / nro.arc / NRO.NRO < prev    next >
Text File  |  1986-05-12  |  11KB  |  386 lines
  1.  
  2. .TH NRO 1 "Ms-Dos Programmer's Manual"
  3. .SH NAME
  4. nro - text processor
  5. .SH SYNOPSIS
  6. .bo
  7. nro [-n] [+n] [-pxx] [-v] [-b] [-mmfile] ifile ... [>ofile]
  8. .SH DESCRIPTION
  9. .ul
  10. NRO
  11. is a text processor and formatter based on the design
  12. provided in 
  13. .bo
  14. "Software Tools"
  15. by Kernighan and Plauger.
  16. The text and commands found in the
  17. .cu
  18. ifile(s)
  19. are processed to
  20. generate formatted text.
  21. The output may be directed into a file or to the printer if
  22. .ul
  23. ofile
  24. is present
  25. in the command line; otherwise, the output will appear at
  26. the user console.
  27. .sp
  28. The
  29. .ul
  30. +n
  31. option causes the output to start with page
  32. .ul
  33. n.
  34. The
  35. .ul
  36. -n
  37. option causes the output to stop after page
  38. .ul
  39. n.
  40. .sp
  41. The
  42. .ul
  43. -v
  44. option prints the version number to the console.
  45. .sp
  46. The
  47. .ul
  48. -p
  49. option causes the output to be shifted to the right by
  50. .ul
  51. xx
  52. spaces.
  53. This has the same effect as the
  54. .cc +
  55. +bo
  56. .po
  57. command.
  58. +cc .
  59. .sp
  60. The
  61. .ul
  62. -b
  63. option allows backspaces to appear in the output text when
  64. underlining or overstriking.
  65. This has the same effect as the
  66. .cc +
  67. +bo
  68. .bs
  69. command with a non-zero argument.
  70. +cc .
  71. .sp
  72. The
  73. .ul
  74. -m
  75. option processes the file
  76. .ul
  77. mfile
  78. for macro definitions.
  79. Note that files processed in this way should contain only macro
  80. definitions, no immediate output should be generated from this file.
  81. .sp
  82. Commands typically are distinguished by a period in column one of the input
  83. followed by a two character abbreviation for the command funtion.
  84. The abbreviation may then be followed by an optional numeric or
  85. character argument.
  86. The numeric argument may be an absolute value such as setting
  87. the right margin to a particular column, or the argument may be
  88. preceded by a plus sign or a minus sign to indicate that the
  89. parameter should be modified relative to a previous setting.
  90. The following commands are recognized:
  91. .sp
  92. .nj
  93. .in +6
  94. .br
  95. .ti -6
  96. .cc !
  97. .bo - causes the following lines of text to appear in
  98. boldface.
  99. The optional argument specifies the number of lines to
  100. be typed in boldface.
  101. Boldface and underlining are mutually exclusive features.
  102. The appearance of a boldface command will cause any underlining
  103. to cease.
  104. !sp
  105. !ti -6
  106. .bp - causes succeeding text to appear at the top of
  107. a new page.
  108. The optional argument specifies the page number for the new page.
  109. The initial value is one and the default value is one more than
  110. the previous page number.
  111. !sp
  112. !ti -6
  113. .br - causes succeeding text to start on a new line at the
  114. current left margin.
  115. There is no numeric argument for this command.
  116. !sp
  117. !ti -6
  118. .bs - enables or disables the appearance of backspaces
  119. in the output text.
  120. Underlining and boldface options are implemented by inserting
  121. character - backspace - character combinations into the output
  122. buffer.
  123. This is fine for devices which properly recognize the backspace
  124. character.
  125. Some printers, however, do not recognize backspaces, so the option is
  126. provided to overprint one line buffer with another.
  127. The first line buffer is terminated with just a carriage return
  128. rather than the carriage return - linefeed combination.
  129. A zero argument or no argument to the backspace command removes
  130. backspaces from the output.
  131. A non-zero argument leaves them in the output.
  132. The default is to remove backspaces.
  133. !sp
  134. !ti -6
  135. .cc - changes the
  136. !ul
  137. NRO
  138. command character to that specified by the character argument.
  139. If no argument is provided, the default is a period.
  140. !sp
  141. !ti -6
  142. .ce - causes the next line of text to appear centered on the output.
  143. The optional argument specifies if more than one line is to be centered.
  144. !sp
  145. !ti -6
  146. .de - causes all text and commands following to be used to define
  147. a macro.
  148. The definition is terminated by a
  149. !bo
  150. .en
  151. command.
  152. The first two characters of the argument following the
  153. !bo
  154. .de
  155. command become the name of the new command.
  156. It should be noted that upper and lower case arguments are considered
  157. different.
  158. Thus, the commands
  159. !bo
  160. .PP
  161. and
  162. !bo
  163. .pp
  164. could define two different macros.
  165. Care should be exercised since existing commands may be redefined.
  166. !sp
  167. A macro may contain up to ten arguments.
  168. In the macro definition, the placement of arguments is designated by the
  169. two character sequences, $0, $1, ... $9.
  170. When the macro is invoked, each argument of the macro command line is
  171. substituted for its corresponding designator in the expansion.
  172. The first argument of the macro command is substituted for the $0
  173. in the expansion, the second argument for the $1, and so forth.
  174. Arguments are typically strings which do not contain blanks or tabs.
  175. If an argument is to contain blanks, then it should be surrounded by
  176. either single or double quotes. 
  177. !sp
  178. !ti -6
  179. .cu - causes the next line(s) of text to be continuously underlined.
  180. Unlike the underline command (see
  181. !bo
  182. .ul)
  183. which underlines only alphanumerics, continuous underlining underlines
  184. all printable characters.
  185. The optional argument specifies the number of lines of text to underlined.
  186. Any normal underlining or boldface commands currently in effect will be
  187. terminated.
  188. !sp
  189. !ti -6
  190. .ef - specifies the text for the footer on even numbered pages.
  191. The format is the same as for the footer command (see
  192. !bo
  193. .fo).
  194. !sp
  195. !ti -6
  196. .eh - specifies the text for the header on even numbered pages.
  197. The format is the same as for the footer command (see
  198. !bo
  199. .fo).
  200. !sp
  201. !ti -6
  202. .en - designates the end of a macro definition.
  203. !sp
  204. !ti -6
  205. .fi - causes the input text to be rearranged or filled to obtain the
  206. maximum word count possible between the previously set left and
  207. right margins.
  208. No argument is expected.
  209. !sp
  210. !ti -6
  211. .fo - specifies text to be used for a footer.
  212. The footer text contains three strings seperated by a delimiter
  213. character.
  214. The first non-blank character following the command is designated
  215. as the delimiter.
  216. The first text string is left justified to the current indentation
  217. value (specified by
  218. !bo
  219. .in).
  220. The second string is centered between the current indentation value
  221. and the current right margin value (specified by
  222. !bo
  223. .rm).
  224. The third string is right justified to the current right margin value.
  225. The absence of footer text will result in the footer being printed as
  226. one blank line.
  227. The presence of the page number character (set by
  228. !bo
  229. .pc)
  230. in the footer text results
  231. in the current page number being inserted at that position.
  232. Multiple occurrances of the page number character are allowed.
  233. !sp
  234. !ti -6
  235. .he - specifies text to be used for a header.
  236. The format is the same as for the footer (see
  237. !bo
  238. .fo).
  239. !sp
  240. !ti -6
  241. .in - indents the left margin to the column value specified by the argument.
  242. The default left margin is set to zero.
  243. !sp
  244. !ti -6
  245. .ju - causes blanks to be inserted between words in a line of
  246. output in order to align or justify the right margin.
  247. The default is to justify.
  248. !sp
  249. !ti -6
  250. .ls - sets the line spacing to the value specified by the argument.
  251. The default is for single spacing.
  252. !sp
  253. !ti -6
  254. .m1 - specifies the number of lines in the header margin.
  255. This is the space from the physical top of page to and including
  256. the header text.
  257. A value of zero causes the header to not be printed.
  258. A value of one causes the header to appear at the physical top of page.
  259. Larger argument values cause the appropriate number of blank
  260. lines to appear before the header is printed.
  261. !sp
  262. !ti -6
  263. .m2 - specifies the number of blank lines to be printed between
  264. the header line and the first line of the processed text.
  265. !sp
  266. !ti -6
  267. .m3 - specifies the number of blank lines to be printed between
  268. the last line of processed text and the footer line.
  269. !sp
  270. !ti -6
  271. .m4 - specifies the number of lines in the footer margin.
  272. This command affects the footer the same way the
  273. !bo
  274. .m1
  275. command
  276. affects the header.
  277. !sp
  278. !ti -6
  279. .ne - specifies a number of lines which should not be broken
  280. across a page boundary.
  281. If the number of lines remaining on a page is less than the
  282. value needed, then a new output page is started.
  283. !sp
  284. !ti -6
  285. .nf - specifies that succeeding text should be printed without
  286. rearrangement, or with no fill.
  287. No argument is expected.
  288. !sp
  289. !ti -6
  290. .nj - specifies that no attempt should be made to align or justify
  291. the right margin.
  292. No argument is expected.
  293. !sp
  294. !ti -6
  295. .nr - causes the value of a number register to be set or modified.
  296. A total of twenty-six number registers are available designated
  297. @@na through @@nz (either upper or lower case is allowed).
  298. When the sequence @@nc is imbedded in the text, the current value
  299. of number register c replaces the sequence, thus, such things as
  300. paragraph numbering can be accomplished with relative ease.
  301. !sp
  302. !ti -6
  303. .of - specifies the text for the footer on odd numbered pages.
  304. The format is the same as the footer command (see
  305. !bo
  306. .fo).
  307. !sp
  308. !ti -6
  309. .oh - specifies the text for the header on odd numbered pages.
  310. The format is the same as the footer command (see
  311. !bo
  312. .fo).
  313. !sp
  314. !ti -6
  315. .pc - specifies the page number character to be used in headers
  316. and footers.
  317. The occurrance of this character in the header or footer text
  318. results in the current page number being printed.
  319. The default for this character is the hash mark (#).
  320. !sp
  321. !ti -6
  322. .pl - specifies the page lenght or the number of lines per output page.
  323. The default is sixty-six.
  324. !sp
  325. !ti -6
  326. .po - specifies a page offset value.
  327. This allows the formatted text to be shifted to the right by
  328. the number of spaces specified.
  329. This feature may also be invoked by a switch on the command line.
  330. !sp
  331. !ti -6
  332. .rm - sets the column value for the right margin.
  333. The default is eighty.
  334. !sp
  335. !ti -6
  336. .so - causes input to be retrieved from the file specified
  337. by the command's character string argument.
  338. The contents of the new file are inserted into the output
  339. stream until an EOF is detected.
  340. Processing of the original file is then resumed.
  341. Command nesting is allowed.
  342. !sp
  343. !ti -6
  344. .sp - specifies a number of blank lines to be output before
  345. printing the next line of text.
  346. !sp
  347. !ti -6
  348. .ti - temporarily alters the indentation or left margin value for a single
  349. succeeding line of text.
  350. !sp
  351. !ti -6
  352. .ul - underlines the alphanumeric text in the following line(s).
  353. The optional argument specifies the number of lines to be underlined.
  354. Underlining and boldface are mutually exclusive features.
  355. The appearance of an underline command cancels any existing
  356. boldface operations.
  357. !cc .
  358. .SH CAVEATS
  359. Wildcard's are supported for DOS 2.0 only, although path names
  360. are not allowed.  The reason for this is that the new DOS 2.0
  361. calls are used to get directory information, but the file open
  362. calls use 1.1 style File Control Blocks.  The program will
  363. execute properly under Dos 1.1, provided wildcards are not used.
  364. .SH AUTHOR
  365. .nf
  366. .nj
  367.  
  368. Original CP/M version by:
  369.  
  370.     Stephen L. Browning
  371.     5723 North Parker Avenue
  372.     Indianapolis, Indiana 46220
  373.  
  374. Converted to run under MS-DOS C86 by:
  375.  
  376.     Jordan A. Bortz
  377.     8711a Harperpoint Dr.
  378.     Cincinnati, OH 45242
  379. 
  380.  
  381.  46220
  382.  
  383. Converted to run under MS-DOS C86 by:
  384.  
  385.     Jordan A. Bortz
  386.     8711a Harperpoint Dr.